1   /*
2    * Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  package com.sun.media.sound;
26  
27  import javax.sound.midi.MidiChannel;
28  
29  /**
30   * ModelChannelMixer is used to process channel voice mix output before going
31   * to master output.<br>
32   * It can be used to:<br>
33   * <ul>
34   *   <li>Implement non-voice oriented instruments.</li>
35   *   <li>Add insert effect to instruments; for example distortion effect.</li>
36   * </ui>
37   * <p>
38   * <b>Warning! Classes that implements ModelChannelMixer must be thread-safe.</b>
39   *
40   * @author Karl Helgason
41   */
42  public interface ModelChannelMixer extends MidiChannel {
43  
44      // Used to process input audio from voices mix.
45      public boolean process(float[][] buffer, int offset, int len);
46  
47      // Is used to trigger that this mixer is not be used
48      // and it should fade out.
49      public void stop();
50  }